LearningSession Class

Represents a user interaction with a SCORM package. Subclasses represent sessions that are stored in LearningStore (StoredLearningSession), and those that are in-memory only representations (UnstoredLearningSession).

Namespace: Microsoft.LearningComponents

Assembly: Microsoft.LearningComponents.dll

Syntax
C#

public abstract class LearningSession

Properties
Name Description
Ð CompletionStatus

Gets or sets completion status for the session.

Ð CurrentActivityDataModel

Gets the data model associated with the current activity in the session.

Ð CurrentActivityEntryPoint

Gets the launching point of the current activity. This may be an absolute Uri, which indicates the resource is not in the package, or a package-relative Uri.

Ð CurrentActivityId

Gets the unique identifier of the current activity. It is unique for all activities in the persisted storage location.

Ð CurrentActivityIsActive

Gets a value which indicates whether the session has a current activity that is active. Returns false if there is no current activity in the session.

Ð CurrentActivityKey

Gets the identifier of the current activity, as provided in the manifest. This is unique per session.

Ð CurrentActivityResourceKey

Gets the identifier of the resource associated with the current activity. The key is derived from the resource identifier in the manifest. It is unique per session.

Ð CurrentActivityResourceParameters

Gets the parameter string to provide to the resource in the activity when the resource is being rendered. An empty string is returned if the value does not exist.

Ð CurrentActivityResourceType

Gets the type of resource of the current activity.

Ð CurrentActivityResourceXmlBase

Gets the xmlbase information for the resource of the currect activity. This uri will be the base uri for any references contained in that resource to other files in the package. The value may be a package-relative or absolute Uri. If the resource does not have an xmlbase value, this property returns null.

Ð HasCurrentActivity

Determines if the session has a current activity.

Ð IsAbandonValid

Gets a boolean indicating if the session is in a state in which the Abandon method may be called.

Ð IsExitValid

Gets a boolean indicating if the session is in a state in which the Exit method may be called.

Ð IsReactivateValid

Returns true if it the session is in a state where Reactivate may be called.

Ð IsResumeValid

Gets a boolean indicating if the session is in a state in which the Resume method may be called.

Ð IsSuspendValid

Gets a boolean indicating if the session is in a state in which the Suspend method may be called.

Ð PackageFormat

Gets the format of the package being processed during this session.

Ð ShowAbandon

Gets an indication if the user interface element to abandon the session should be shown.

Ð ShowExit

Gets an indication if the user interface element indicating 'exit' should be shown.

Ð ShowNext

Returns true if the associated user interface element indicating 'continue to next activity' should be shown.

Ð ShowPrevious

Gets an indication if the user interface element indicating 'return to previous activity' should be shown.

Ð ShowSave

Gets an indication if the user interface element to save the session should be shown.

Ð SuccessStatus

Gets success status for the session.

Ð Title

Gets the title of the session. This is the title of the root activity in the session, if provided, otherwise, a default title is returned.

Ð TotalPoints

Gets a points value for the session.

Ð View

Gets the view of the current session.

Methods
Name Description
Ð Abandon

Stops the session by abandoning all activities in the session.

Ð AbandonCurrentActivity

Stops the current activity by abandoning it without saving data and without further processing of navigation rules.

Ð CommitChanges

Saves any data of this session that has not been saved. You must call this method to ensure changes are persisted in long-term storage.

Ð Exit

Immediately exits the session without processing any pending navigation requests.

Ð ExitCurrentActivity

Immediately exits the current activity without processing any pending navigation requests and without saving any data model values that have not been committed.

Ð GetTableOfContents ()

Gets the table of contents information for the activity tree of the current session, without evaluating the sequencing rules to determine if activities are accessible in the current state of the session.

Ð GetTableOfContents (bool)

Gets the table of contents information for the activity tree of the current session.

Ð IsMoveToActivityValid (long)

Gets a boolean value indicating whether or not moving to the selected activity is a valid operation. The activity is identified by it's unique numerical id.

Ð IsMoveToActivityValid (string)

Gets a boolean value indicating whether or not moving to the selected activity is a valid operation.

Ð IsMoveToNextValid

Gets a boolean value indicating whether or not moving to the next activity is a valid operation.

Ð IsMoveToPreviousValid

Gets a boolean value indicating whether or not moving to the previous activity is a valid operation.

Ð MoveToActivity (long)

Makes the selected activity the current activity, using the unique activity id.

Ð MoveToActivity (string)

Makes the selected activity the current activity.

Ð MoveToNext

Moves to the next activity in the session. For UnstoredLearningSession, this is determined by a pre-order traversal of the activity tree and navigation rules as defined in the package manifest are not enforced. For a session that represents an active attempt, this is determined through sequencing rules of the package and the progress of the user through it.

Ð MoveToPrevious

Moves to the previous activity in the session. For UnstoredLearningSession or views of sessions that are not active, this is determined by an in order traversal of the activity tree and navigation rules as defined in the package manifest are not enforced. For a session that represents an active attempt, this is determined through sequencing rules of the package.

Ð ProcessFormData

Process the data returned from the client.

Ð ProcessNavigationRequests

Processes all of the pending navigation requests in the current activity's data model.

Ð Reactivate

Reactivate a session that has been completed or abandoned.

Ð Render

Reads a file from within the package associated with this session and writes it to an HttpResponse.

Ð Resume

Resumes a suspended session. Once the session has been resumed, it is considered active.

Ð Suspend

Temporarily suspends the the current session. It may be resumed at a later time.

Ï ValidateRenderPath

Validates that the requested path can be rendered. Throws the appropriate exception if the request is not allowed.

Remarks

TODO: Concepts to define

  1. Exit
  2. Terminate
  3. Suspend
  4. Abandon
  5. Active session
  6. Current activity
  7. Root activity
  8. Session status (or Attempt status)
  9. Attempt -- Does this need to be defined?
  10. View

A description of the views of LearningSession:

  1. Execute view (SessionView.Execute): Represents a view of a learner interacting (attempting) a course. All navigation rules are processed in this view. Committed data is stored in LearningStore. Data persists between instances of LearningSession.
  2. Review view (SessionView.Review): Represents a view of a previously executed session, without regard to navigation rules. Allows accessing any activity that contains a resource. The session does not need to be ended in order to review it. Data of the executed session was previously stored in LearningStore and this view allows viewing it. It does not allow modifying any of the stored data.
  3. Random access view (SessionView.RandomAccess): During random access, the application can access any activity in any order, primarily for the purpose of reading and/or updating the SCORM Data Model for that activity, without regard to SCORM Sequencing and Navigation rules. Allows accessing any activity in the activity tree of the content being executed. The attempt does not have to be ended to view a session in this way. Activities without associated resources may be modified in this view. Committed data is stored in LearningStore. Data persists between instances of LearningSession. When changes are committed, RandomAccessView saves the data model changes, not any global information. It will also not save any changes made to the CurrentActivity or other attempt level data.